home *** CD-ROM | disk | FTP | other *** search
/ Turnbull China Bikeride / Turnbull China Bikeride - Disc 2.iso / STUTTGART / UNIXTOOL / MANSRC / _files / _mansrc / man_page < prev    next >
Encoding:
Text File  |  1991-06-28  |  2.7 KB  |  87 lines
  1. MAN(1)                       USER COMMAND                           MAN(1)
  2.  
  3.  
  4.  
  5. NAME 
  6.  
  7.         man - print manual pages
  8.  
  9. SYNOPSIS
  10.  
  11.         man [section] title
  12.         man -k keyword
  13.         man -i 
  14.         man -s string
  15.  
  16. DESCRIPTION
  17.  
  18.         Finds and prints pages from the on-line manual.  However, unlike
  19.         it's UNIX(c) equivalent, these manual pages are ascii formatted.
  20.  
  21.         <man$path>    manual sections base directory, defaults to $.usr.man
  22.         <man$com>     command to display page, defaults to TYPE
  23.  
  24.         Unless a section is given a directory-walk is started from the
  25.         manual base directory looking for the specified page.
  26.         
  27.         If no title is given then a default of '*' (wildcard) is assumed,
  28.         but will only be accepted if used in conjunction with another
  29.         option.
  30.  
  31.         -k     searches sections for an index file 'list' which lists all
  32.                the keywords associated with every page.
  33.  
  34.         -i     only displays the location of the manual page
  35.  
  36.         -s     search for a string within a manual page 
  37.  
  38. FILES
  39.  
  40.         <man$path>     If defined then is used to indicate the location of
  41.                        the base directory in which manual sections are found
  42.                        otherwise default of $.usr.man is assumed.
  43.  
  44.         <man$com>      If defined then gives the name of command used to 
  45.                        display manual page, otherwise defaults to TYPE
  46.  
  47.         The format of the index file 'list' should be :
  48.  
  49.         LIST(1)                  USER COMMANDS                    LIST(1)
  50.  
  51.         LIST OF COMMANDS
  52.  
  53.         Name                Appears on Page     Description
  54.         .                   .                   .
  55.        /!\                 /!\                 /!\ 
  56.         !                   !                   !
  57.         page title          page filename       brief description    
  58.  
  59.         
  60. AUTHOR
  61.  
  62.         Steve van Aardt  
  63.  
  64.         contact:     until June 1991   : vanaards@uk.man.cs.p4
  65.                      otherwise contact : 2 Oakmere, 
  66.                                          Chorley Old Road,
  67.                                          Brindle,
  68.                                          Lancashire, PR6 8RP.
  69.                                          England.
  70.  
  71. DIAGNOSTICS
  72.  
  73.         Hopefully most errors have been catered for, should the program
  74.         fail otherwise then that would be a bug and should be noted as
  75.         such.
  76.  
  77. BUGS
  78.  
  79.         If several similar manual pages exists within different sections
  80.         then unless restricted to one section, these will all be displayed.
  81.  
  82.         option -k isn't compatible with that on the UNIX(c) man command
  83.         option -i could be improved.
  84.         option -s is slow !
  85.        
  86.         Better use of the indexes could be added.
  87.